////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (c) 2010 Leon Coto Rodriguez
//  leoncoto@gmail.com
//  
//  Permission is hereby granted, free of charge, to any person
//  obtaining a copy of this software and associated documentation
//  files (the "Software"), to deal in the Software without
//  restriction, including without limitation the rights to use,
//  copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the
//  Software is furnished to do so, subject to the following
//  conditions:
//  
//   The above copyright notice and this permission notice shall be
//   included in all copies or substantial portions of the Software.
//  
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
//  OTHER DEALINGS IN THE SOFTWARE.
//
////////////////////////////////////////////////////////////////////////////////
package org.flexspeedup.delegate
{
import org.flexspeedup.model.IResultSet;

/**
 * Implementing this interface means a class is capable of controlling page
 * navigation in collections.
 */
public interface IPageNavigationDelegate
{
    //--------------------------------------------------------------------------
    //
    //  Properties
    //
    //--------------------------------------------------------------------------

    //--------------------------------
    // resultSet
    //--------------------------------
    /**
     * The resultset associated with the pagination
     */
    function get resultSet():IResultSet;
    function set resultSet(value:IResultSet):void;
    
    //--------------------------------------------------------------------------
    //
    //  Methods
    //
    //--------------------------------------------------------------------------    
    
    //----------------------------------
    //  gotoNextPage
    //----------------------------------
    /**
     * Goes to the next page in the collection.
     */
    function gotoNextPage():void;
    
    //----------------------------------
    //  gotoPreviousPage
    //----------------------------------
    /**
     * Goes to the previous page in the collection
     */
    function gotoPreviousPage():void;

    //----------------------------------
    //  gotoFirstPage
    //----------------------------------
    /**
     * Goes to the first page in the collection
     */
    function gotoFirstPage():void
    
    //----------------------------------
    //  gotoLastPage
    //----------------------------------
    /**
     * Goes to the last page in the collection
     */
    function gotoLastPage():void

    //----------------------------------
    //  gotoPage
    //----------------------------------
    /**
     * Goes to a page in the collection using a page number
     * @param int The page to go in the collection
     */
    function gotoPage(pageNumber:int):void;
    
}
}